dundas.view.ViewService Class

 

Inheritance Hierarchy

 
Class
   dundas.Component
      dundas.Service
         dundas.view.ViewService
 

Constructors

 
  Name Description
init Initializes the ViewService. Called during construction.
 
 

Properties

 
  Name Description
annotationbar Gets or sets the UI control that is for the annotation bar.
applicationCoreContainer Gets a value that holds a reference to the application container element.
applicationElement Gets a value that holds a reference to the application element.
currentDialogShown Gets the current dialog shown.
currentFocusedControl Gets or sets the UI control that is currently in context.
currentUIContext Gets the toppest (and the current) UI context.
dialogBackgroundBlocker Gets a value that holds a reference to the dialog blocker.
dialogCount Gets a value with the number of visible dialogs.
dialogs Gets all the dialogs currently shown.
eventsManager Inherited from dundas.Service.
formulabar Gets or sets the UI control that is for the formula bar.
isAlertShowing Gets a value indicating whether any alerts are showing.
isBarShowing Gets a value indicating whether any bars are showing.
isDialogShowing Gets a value indicating whether any dialogs are showing.
isDisposed Gets a value indicating whether this instance has been disposed. Inherited from dundas.Component.
isErrorsIgnored Gets or sets a value indicating whether the errors are ignored or not.
mainMenu Gets or sets a value that holds a reference to the Main Menu in the application.
measureValuebar Gets or sets the UI control that is for the measure value bar.
naturalLanguageBar Gets the UI control that is for the natural language bar.
parameterbar Gets or sets the UI control that is for the parameter bar.
site Gets or sets the site that this component is a part of. Inherited from dundas.Component.
taskbar Gets or sets a value that holds a reference to the Taskbar in the application.
toolbar Gets or sets a value that holds a reference to the Toolbar in the application.
uniqueId Gets or sets the unique ID of this component within the site. Inherited from dundas.Component.
 
 

Methods

 
  Name Description
bind Subscribe a handler for an event. Inherited from dundas.Service.
clearUIContext Clear all the UI contexts in the stack.
closeAllBars Hides all the UI bars.
closeAllDialogs Closes all the dialogs currently shown in the application.
closeDialog Closes the dialog with the specified ID.
confirmCloseAllDialogs Warns the user, if applicable, that closing the dialogs could lose information.
createDelegate Helper for creating delegate functions. Inherited from dundas.Component.
createTimeout Creates a timeout. Inherited from dundas.Component.
dispatch Dispatches a call by creating a delegate and running it right away on a timer. Inherited from dundas.Component.
dispose Inherited from dundas.Component.
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
getService Gets the requested service. Inherited from dundas.Component.
getTopAnnotationBar Gets the top-most annotation bar. This might be the one on this window, but it may also be the parent (if it's embedded).
getTopMeasureValueBar Gets the top-most measure value bar. This might be the one on this window, but it may also be the parent (if it's embedded).
hideLoading Hides the loading overlay.
navigateToPage Navigates to the requested page with additional optional options.
onLoaded Called when the service is loaded. Inherited from dundas.Service.
openHelpPage Opens a new window which will navigate to the help page.
popUIContext Pop a UI context off the stack.
preloadImage Preload given image url.
preloadImages Preload list of image urls.
pushUIContext Push a UI context on the stack.
showAlert Shows an alert to the user (message with an 'ok' button).
showConfirm Shows a confirmation to the user (message with 'ok' and 'cancel' buttons).
showDialog Shows a dialog. The level of the dialog is auto-determined by how many dialogs are already shown (if auto close is disabled). Since this show method will close any previous cloned dialogs, all event tying should be done after this method is called.
showError Shows the given error in the application.
showFileWarnings When given a file, will attempt to show the warnings (if any). This should be used after loading a new entity on a screen.
showLoading Shows the loading overlay.
showLoadingRestCall Blocks the UI for the duration of the REST API call, and automatically reports an error if it occurs. This call is designed to be used along with the dundas REST API JavaScript methods.
showSignal Shows a short-lived signal to the user.
subscribe Subscribe or unsubscribe an event handler for an event. Inherited from dundas.Service.
subscribeFocusChanged Subscribe an event handler for focus changed.
subscribeOnce Subscribe a one time handler for an event. Inherited from dundas.Service.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.
trigger Triggers an event. Inherited from dundas.Service.
unbind Unsubscribe an event. Inherited from dundas.Service.